GET /manage/v2/databases/{id|name}/alert/actions/{id|name}
Summary
Return the configuration for the specified alert action.
URL Parameters
uri
The URI of the alert for which to return the action.
This parameter is required.
format
The format of the data in the response body.
Allowed values: html, json or xml (default). Use this
parameter to override the Accept header.
Request Headers
Accept
The desired MIME type of the data in the response
body. If the format parameter is present, it takes precedence over this header.
Supported values: application/xml (default), application/json,
text/html.
Content-type
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response Headers
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response
Upon success, MarkLogic server returns status code 200 (OK) and the response
body contains the requested data. A status code of 401 (Unauthorized) is returned if the user
does not have the necessary privileges.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
The structure of the output returned from
this REST API is as follows:
name
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2?uri=my-alert-config
==> Retrieve the configuration of the alert action with the id, "xdmp:log2."
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.